/*
 Copyright (c) 2009 Rafal Szemraj - http://szemraj.eu

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 of the Software, and to permit persons to whom the Software is furnished to do so,
 subject to the following conditions:

 The above copyright notice and this permission notice shall be included in all 
 copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
 FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
*/
package eu.szemraj.data {

   /**
    * Basic Java Enum class implementation, for example:
    * <p>
    * <listing>
    * <pre>
    * com.company.enums.WeekDay extends Enum {
    * 
    *   public static const MONDAY:WeekDay 		= new WeekDay( "Monday, 	0 );    *   public static const TUESDAY:WeekDay 	= new WeekDay( "Tuesday", 	1 );    *   public static const WEDNESDAY:WeekDay 	= new WeekDay( "Wednesday, 	2 );    *   public static const THURSDAY:WeekDay 	= new WeekDay( "Thursday, 	3 );    *   public static const FRIDAY:WeekDay 		= new WeekDay( "Friday, 	4 );    *   public static const SATURDAY:WeekDay 	= new WeekDay( "Saturday, 	5 );    *   public static const SUNDAY:WeekDay 		= new WeekDay( "Sunday, 	6 );
    *   public function WeekDay( weekDayName:String, weekDayIndex:int ) {
    *   
    *   	super( weekDayName, weekDayIndex );
    *   
    *   }
    * 
    * }
    * 
    * [...]
    * 
    * var day:WeekDay;
    * switch( day ) {
    * 
    * 	case WeekDay.MONDAY : ...
    * 
    * }
    * </pre>
    * </listing>
    * </p>
    */
   public class Enum {

      private var _name:String;
      private var _index:int;
      

	 /**
	  * @param name name of the Enum instance	  * @param index index of the Enum instance
	  */
      public function Enum( name:String, index:int ) {
      	
         _name = name;
         _index = index;
      }
	  
	  /**
	   * Returns enum name
	   */
      public function get name():String {
      	
         return _name;	
      }

	  /**
	   * Returns enum index value
	   */
      public function get index():int {
      	
         return _index;
      }
      
      /**
       * Returns enum string representation
       */
      public function toString():String {
      	
      	return "[ " + name + ", " + index + " ]";	
      	
      }
   }
}
